KCAddAppleSharePassword

KCAddAppleSharePassword
Header:	Keychain.h		Carbon status:	Under Evaluation

Adds a new AppleShare server password to the default keychain.

OSStatus KCAddAppleSharePassword (
    AFPServerSignature *serverSignature, 
    StringPtr serverAddress, 
    StringPtr serverName, 
    StringPtr volumeName, 
    StringPtr accountName, 
    UInt32 passwordLength, 
    const void *passwordData, 
    KCItemRef *item
);

serverSignature: A pointer to a 16-byte Apple File Protocol server signature block. Pass a value of type AFPServerSignature. Pass NULL to match any server signature. The Keychain Manager identifies the location for the password by the information passed in the serverAddress and serverSignature parameters. You must pass a valid value in at least one of these parameters.
serverAddress: A pointer to a Pascal string containing the server address, which may be specified as an AppleTalk zone name, a DNS domain name (in the format "xxx.yyy.zzz"), or an IP address (in the format "111.222.333.444"). The Keychain Manager identifies the location for the password by the information passed in the serverAddress and serverSignature parameters. You must pass a valid value in at least one of these parameters.
serverName: A pointer to a Pascal string containing the server name.
volumeName: A pointer to a Pascal string containing the volume name.
accountName: A pointer to a Pascal string containing the account name.
passwordLength: The length of the buffer pointed to by passwordData.
passwordData: A pointer to a buffer which will hold the returned password data. Before calling KCAddAppleSharePassword, allocate enough memory for the buffer to hold the data you want to store.
item: On return, a pointer to a reference to the added item. Pass NULL if you don’t want to obtain this reference.

function result: A result code. The result code errKCNoDefaultKeychain indicates that no default keychain could be found. The result code errKCDuplicateItem indicates that you tried to add a password that already exists in the keychain. The result code errKCDataTooLarge indicates that you tried to add more data than is allowed for a record of this type.

DISCUSSION

The KCAddAppleSharePassword function adds a new AppleShare server password to the default keychain that is uniquely identified by the serverName, volumeName, accountName parameters, and a location specified either by serverAddress or serverSignature. KCAddAppleSharePassword optionally returns a reference to the newly added item.

Most applications do not need to store AppleShare password data, as this is handled transparently by the AppleShare client software. To be compatible with the AppleShare client, you should store a fully-specified File Manager structure AFPXVolMountInfo as the password data.

VERSION NOTES

Available beginning with Keychain Manager 1.0. In Keychain Manager 1.0, the kcaddapplesharepassword function provides the same functionality as KCAddAppleSharePassword, except that it accepts C strings rather than Pascal strings as arguments. In Keychain 2.0, you should use KCAddAppleSharePassword, since kcaddapplesharepassword is provided for convenience only and may be removed from the header file at some point in the future.

AVAILABILITY

Under evaluation for Carbon. Available in CarbonLib 1.0 and later when KeychainLib 1.0 or later is installed. Exported by CarbonLib 1.0 and later and by KeychainLib 1.0 and later.